home *** CD-ROM | disk | FTP | other *** search
/ Collection of Tools & Utilities / Collection of Tools and Utilities.iso / tex / blurb_20.zip / BLURB.DOC < prev    next >
Text File  |  1992-04-28  |  10KB  |  199 lines
  1. ===============================================================================
  2.                                      BLURB
  3.                                   Version 2.0
  4.                                      4/28/92
  5. ===============================================================================
  6.               Copyright(c) 1992, Jon Privatt, All Rights Reserved
  7. -------------------------------------------------------------------------------
  8.  
  9.  
  10. What this Blurb thing, anyway?
  11. -----------------------------
  12.   Blurb is a program that chooses a random line from a file and prints it on
  13. the screen in a decent manner.  The file of blurbs can be jokes, fortunes,
  14. quotes, philosophical sayings, or whatever you want.
  15.  
  16.  
  17. The problem:
  18. -----------
  19.   For quite some time I have been searching for a decent program that would
  20. print sayings on my screen in a decent manner from my autoexec.bat file.
  21. I wanted a program that would read a normal ASCII text file that I could
  22. change very easily.  I found a couple, but they were either too clumsy or used
  23. files which could not be easily altered.  Grief and frustration finally kicked
  24. in and motivated me and the original Blurb 1.0 was born!  It is a sad, but
  25. workable program which was crammed out in less than 1 hour in compilable BASIC.
  26. It is reliable and small but has its flaws. I had installed it on couple of 
  27. friends' systems and they agreed, Blurb 1.0 was an interesting program.
  28. However, as time went on and they added more and more blurbs to the list, it
  29. began to manifest it's major flaw...speed.  It was taking an average of 30 sec.
  30. to choose a blurb from a list of 2000.  In order to salvage what was left of
  31. our friendship, I removed the Blurb 1.0 from their system, logged their various
  32. complaints and suggestions and headed back to the drawing board.
  33.  
  34.  
  35. The Solution - Blurb 2.0:
  36. ------------------------
  37.   My goal was a program that was non-obtrusive, easy-to-use, and still be 
  38. intelligent enough to detect differences in user preferences and system 
  39. configurations and work around them.  My goal was to rewrite the entire program
  40. in C++ which would give me greater control over the system file access than a
  41. BASIC programming language could.  At the same time, I wanted to make the 
  42. program smart enough to detect changes in various file configurations and deal
  43. with them automatically.  My speed goal was a blurb off the harddrive from a
  44. list of 5000 in no more than two seconds, even on the slowest of systems.
  45. Blurb 2.0 meets these standards (and then some)!
  46.  
  47.  
  48. Features:
  49. --------
  50.   *  Main program and setup contained in a single file.
  51.   *  Indexed blurb file for very fast access.
  52.   *  File structure is of non-uniform record sizes (saves a lot of disk space).
  53.   *  Auto-adaptation to most screen widths.
  54.   *  User definable colors.
  55.   *  Optional borders.
  56.   *  Program name & author title line may be optionally hidden.
  57.   *  Optional delay after printing blurb to screen.
  58.   *  Delay is variable depending on number of words in a given blurb and the
  59.        user selected time to pause per each word.
  60.   *  Delay can be instantly bypassed by the user by pressing a key.
  61.   *  Program automatically finds and places .idx and .cfg files.
  62.   *  No need for continuous command-line options as they're saved in .cfg file.
  63.   *  Program automatically detects changes in the file BLURBS and reindexes.
  64.   *  User may optionally view blurbs in a sequential or random order.
  65.   *  System ignores blank lines in blurb file.   
  66.  
  67.  
  68. How Fast is Fast?
  69. ----------------
  70.   Blurb 2.0 surpasses the benchmark test of 300,000 blurbs (occupying 14.5 meg)
  71. by choosing a blurb in under 1 second when running on my slow SCSI hard drive.
  72. In fact, performance is consistent on all systems I have tested Blurb 2.0 on, 
  73. regardless of whether there are 10, 5000, or 300,000 blurbs!  Blurb 2.0 has
  74. theoretical limitations approaching 4.3 billion blurbs and blurb file sizes 
  75. of over 2.1 gigabytes with a maximum individual blurb size of 1000 characters.
  76.  
  77.  
  78. Blurb Installation:
  79. ------------------
  80.   Installation is a simple matter.  Only two files are required, BLURB.EXE and
  81. BLURBS.  The former is the program, and the latter contains the actual blurbs.
  82. Just make sure that these two files are located somewhere in the system PATH.
  83.  
  84.   Packing List:
  85.      Blurb.exe            The main program.
  86.      Blurb.doc            This file your are reading now.
  87.      Blurbs               A small collection of fortunes to get you started.
  88.  
  89.   The first time you run the program, it will reindex itself.  This is normal
  90. and will only occur when the program senses that the file BLURBS has been
  91. changed in some way.  (Reindexing may take some time as the number of blurbs
  92. increases, but it is a necessary and infrequent step in achieving high-speed
  93. file access.  The amount of time required to re-index should give you a pretty
  94. good idea how slow Blurb version 1.0 was.)
  95.  
  96.   After it is finished reindexing, Blurb reports how many blurbs there are
  97. and then it halts.  Blurb is now ready for normal operation.  All you have to
  98. do to use it is to run it again.
  99.  
  100.  
  101. Using Blurb:
  102. -----------
  103.   When the program runs, it automatically finds and places the two support
  104. files that it requires, BLURB.CFG (the configuration file) and BLURB.IDX (the
  105. index file to the blurbs themselves).  If any update has occurred to the file,
  106. BLURBS, the program will automatically detect the change and reindex the file.
  107.  
  108.   Various command-line options:
  109.  
  110.     Blurb             This is the normal command that will be used to operate
  111.                         the program.
  112.     Blurb ?           This will print out a summary of these commands.
  113.     Blurb /setup      Calls the set-up menu which will update the configuration
  114.                         file (BLURB.CFG).
  115.     Blurb /info       Prints out various information about the program's 
  116.                         current status.
  117.     Blurb /index      Forces a manual reindex of the file BLURBS.  This is
  118.                         usually detected automatically, but the option is here.
  119.     Blurb /delay      Overrides delay option in setup menu and uses a delay
  120.                         after displaying a blurb.
  121.     Blurb /nodelay    Overrides delay option in setup menu and does not use
  122.                         a delay after displaying the blurb.
  123.  
  124. Setup Options:
  125. -------------
  126. <A>uto Time Delay     Selects and deselects whether or not there is a pause
  127.                         after the blurb has been selected.  Default: OFF
  128.  
  129. <D>elay               When the Auto Time Delay is on, this is the delay that
  130.                         is used.  The total delay is equal to this delay
  131.                         multiplied by the number of words that in the blurb.
  132.                         This value is in 100th's of a second.  Default: 50
  133.  
  134. <B>ackground Color    This options cycles through the possible background
  135.                         colors.  Results of color changes will be seen
  136.                         instantly in the menu.  Default:  Blue
  137.  
  138. <F>oreground Color    Cycles through all of the possible foreground colors.
  139.                         (Same as <B>ackground Colors)  Default: Bright White
  140.  
  141. <H>ide the Title      Makes the top line author, title and version number
  142.                         either visible or masked.  Default: VISIBLE
  143.  
  144. <O>utlining Border    Selects and deselects the border which appears around
  145.                         the blurb.  Default: ON
  146.  
  147. <S>election Method    Allows the user to decide whether to see blurbs in a 
  148.                         RANDOMIZED order, or see the blurbs in a INORDER
  149.                         sequential order.  Default: RANDOMIZED
  150.  
  151.  
  152. Where Can I Find More Blurbs?
  153. ----------------------------
  154.   I have enclosed a few blurbs with the original packaging in order to hold you
  155. over until you begin collecting the sort of things you really want to see
  156. coming up on your screen.  The most common place to find these things is on 
  157. BBS systems, usually in the text file download areas.  There are a great deal 
  158. of them out there concerning a variety of different subjects.  All